<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- /fasttmp/mkdist-qt-4.3.5-1211793125/qtopia-core-opensource-src-4.3.5/src/qt3support/widgets/q3toolbar.cpp -->
<head>
  <title>Qt 4.3: Q3ToolBar Class Reference</title>
  <link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://www.trolltech.com/products/qt"><img src="images/qt-logo.png" align="left" width="32" height="32" border="0" /></a></td>
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="modules.html"><font color="#004faf">Modules</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"><a href="http://www.trolltech.com"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></a></td></tr></table><h1 align="center">Q3ToolBar Class Reference<br /><sup><sup>[<a href="qt3support.html">Qt3Support</a> module]</sup></sup></h1>
<p>The Q3ToolBar class provides a movable panel containing widgets such as tool buttons. <a href="#details">More...</a></p>
<pre> #include &lt;Q3ToolBar&gt;</pre><p><b>This class is part of the Qt 3 support library.</b> It is provided to keep old source code working. We strongly advise against using it in new code. See <a href="porting4.html#qtoolbar">Porting to Qt 4</a> for more information.</p>
<p>Inherits <a href="q3dockwindow.html">Q3DockWindow</a>.</p>
<ul>
<li><a href="q3toolbar-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="properties"></a>
<h3>Properties</h3>
<ul>
<li><div class="fn"/><b><a href="q3toolbar.html#label-prop">label</a></b> : QString</li>
</ul>
<ul>
<li><div class="fn"/>10 properties inherited from <a href="q3dockwindow.html#properties">Q3DockWindow</a></li>
<li><div class="fn"/>2 properties inherited from <a href="q3frame.html#properties">Q3Frame</a></li>
<li><div class="fn"/>6 properties inherited from <a href="qframe.html#properties">QFrame</a></li>
<li><div class="fn"/>56 properties inherited from <a href="qwidget.html#properties">QWidget</a></li>
<li><div class="fn"/>1 property inherited from <a href="qobject.html#properties">QObject</a></li>
</ul>
<a name="public-functions"></a>
<h3>Public Functions</h3>
<ul>
<li><div class="fn"/><b><a href="q3toolbar.html#Q3ToolBar">Q3ToolBar</a></b> ( const QString &amp; <i>label</i>, Q3MainWindow * <i>parent</i>, Qt::ToolBarDock <i>dock</i> = Qt::DockTop, bool <i>newLine</i> = false, const char * <i>name</i> = 0 )</li>
<li><div class="fn"/><b><a href="q3toolbar.html#Q3ToolBar-2">Q3ToolBar</a></b> ( const QString &amp; <i>label</i>, Q3MainWindow * <i>mainWindow</i>, QWidget * <i>parent</i>, bool <i>newLine</i> = false, const char * <i>name</i> = 0, Qt::WindowFlags <i>f</i> = 0 )</li>
<li><div class="fn"/><b><a href="q3toolbar.html#Q3ToolBar-3">Q3ToolBar</a></b> ( Q3MainWindow * <i>parent</i> = 0, const char * <i>name</i> = 0 )</li>
<li><div class="fn"/><b><a href="q3toolbar.html#dtor.Q3ToolBar">~Q3ToolBar</a></b> ()</li>
<li><div class="fn"/>void <b><a href="q3toolbar.html#addSeparator">addSeparator</a></b> ()</li>
<li><div class="fn"/>virtual void <b><a href="q3toolbar.html#clear">clear</a></b> ()</li>
<li><div class="fn"/>QString <b><a href="q3toolbar.html#label-prop">label</a></b> () const</li>
<li><div class="fn"/>Q3MainWindow * <b><a href="q3toolbar.html#mainWindow">mainWindow</a></b> () const</li>
<li><div class="fn"/>virtual void <b><a href="q3toolbar.html#label-prop">setLabel</a></b> ( const QString &amp; )</li>
<li><div class="fn"/>virtual void <b><a href="q3toolbar.html#setStretchableWidget">setStretchableWidget</a></b> ( QWidget * <i>w</i> )</li>
</ul>
<ul>
<li><div class="fn"/>32 public functions inherited from <a href="q3dockwindow.html#public-functions">Q3DockWindow</a></li>
<li><div class="fn"/>4 public functions inherited from <a href="q3frame.html#public-functions">Q3Frame</a></li>
<li><div class="fn"/>13 public functions inherited from <a href="qframe.html#public-functions">QFrame</a></li>
<li><div class="fn"/>201 public functions inherited from <a href="qwidget.html#public-functions">QWidget</a></li>
<li><div class="fn"/>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
<li><div class="fn"/>12 public functions inherited from <a href="qpaintdevice.html#public-functions">QPaintDevice</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li><div class="fn"/>4 public slots inherited from <a href="q3dockwindow.html#public-slots">Q3DockWindow</a></li>
<li><div class="fn"/>19 public slots inherited from <a href="qwidget.html#public-slots">QWidget</a></li>
<li><div class="fn"/>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>
<li><div class="fn"/>3 signals inherited from <a href="q3dockwindow.html#signals">Q3DockWindow</a></li>
<li><div class="fn"/>1 signal inherited from <a href="qwidget.html#signals">QWidget</a></li>
<li><div class="fn"/>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>
<li><div class="fn"/>4 static public members inherited from <a href="qwidget.html#static-public-members">QWidget</a></li>
<li><div class="fn"/>5 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>
<li><div class="fn"/>5 protected functions inherited from <a href="q3frame.html#protected-functions">Q3Frame</a></li>
<li><div class="fn"/>38 protected functions inherited from <a href="qwidget.html#protected-functions">QWidget</a></li>
<li><div class="fn"/>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>
<li><div class="fn"/>1 protected function inherited from <a href="qpaintdevice.html#protected-functions">QPaintDevice</a></li>
<li><div class="fn"/>1 protected slot inherited from <a href="qwidget.html#protected-slots">QWidget</a></li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The Q3ToolBar class provides a movable panel containing widgets such as tool buttons.</p>
<p>A toolbar is a panel that contains a set of controls, usually represented by small icons. It's purpose is to provide quick access to frequently used commands or options. Within a <a href="q3mainwindow.html">Q3MainWindow</a> the user can drag toolbars within and between the <a href="q3dockarea.html">dock areas</a>. Toolbars can also be dragged out of any dock area to float freely as top-level windows.</p>
<p>Q3ToolBar is a specialization of <a href="porting4.html#qdockwindow">QDockWindow</a>, and so provides all the functionality of a <a href="porting4.html#qdockwindow">QDockWindow</a>.</p>
<p>To use Q3ToolBar you simply create a Q3ToolBar as a child of a <a href="q3mainwindow.html">Q3MainWindow</a>, create a number of <a href="qtoolbutton.html">QToolButton</a> widgets (or other widgets) in left to right (or top to bottom) order and call <a href="q3toolbar.html#addSeparator">addSeparator</a>() when you want a separator. When a toolbar is floated the caption used is the label given in the constructor call. This can be changed with <a href="q3toolbar.html#label-prop">setLabel</a>().</p>
<p>You may use most widgets within a toolbar, with <a href="qtoolbutton.html">QToolButton</a> and <a href="qcombobox.html">QComboBox</a> being the most common. But note that the toolbar's actions must be <a href="q3action.html">Q3Action</a>s.</p>
<p>If you create a new widget on an already visible Q3ToolBar, this widget will automatically become visible without needing a <a href="qwidget.html#show">show</a>() call. (This differs from every other Qt widget container. We recommend calling <a href="qwidget.html#show">show</a>() anyway since we hope to fix this anomaly in a future release.)</p>
<p>Q3ToolBars, like QDockWindows, are located in <a href="q3dockarea.html">Q3DockArea</a>s or float as top-level windows. <a href="q3mainwindow.html">Q3MainWindow</a> provides four Q3DockAreas (top, left, right and bottom). When you create a new toolbar (as in the example above) as a child of a <a href="q3mainwindow.html">Q3MainWindow</a> the toolbar will be added to the top dock area. You can move it to another dock area (or float it) by calling <a href="q3mainwindow.html#moveDockWindow">Q3MainWindow::moveDockWindow</a>(). Dock areas lay out their windows in lines.</p>
<p>If the main window is resized so that the area occupied by the toolbar is too small to show all its widgets a little arrow button (which looks like a right-pointing chevron, '&amp;#187;') will appear at the right or bottom of the toolbar depending on its orientation. Clicking this button pops up a menu that shows the 'overflowing' items. QToolButtons are represented in the menu using their textLabel property, other <a href="qabstractbutton.html">QAbstractButton</a> subclasses are represented using their text property, and QComboBoxes are represented as submenus, with the caption text being used in the submenu item.</p>
<p>Usually a toolbar will get precisely the space it needs. However, with <a href="q3dockwindow.html#setHorizontalStretchable">setHorizontalStretchable</a>(), <a href="q3dockwindow.html#setVerticalStretchable">setVerticalStretchable</a>() or <a href="q3toolbar.html#setStretchableWidget">setStretchableWidget</a>() you can tell the main window to expand the toolbar to fill all available space in the specified orientation.</p>
<p>The toolbar arranges its buttons either horizontally or vertically (see <a href="q3dockwindow.html#orientation">orientation</a>() for details). Generally, <a href="q3dockarea.html">Q3DockArea</a> will set the orientation correctly for you, but you can set it yourself with <a href="q3dockwindow.html#setOrientation">setOrientation</a>() and track any changes by connecting to the <a href="q3dockwindow.html#orientationChanged">orientationChanged</a>() signal.</p>
<p>You can use the <a href="q3toolbar.html#clear">clear</a>() method to remove all items from a toolbar.</p>
<p align="center"><img src="images/qdockwindow.png" alt="Toolbar (dock window)" /></p><p>A floating <a href="porting4.html#qtoolbar">QToolbar</a> (dock window)</p>
<p>See also <a href="qtoolbutton.html">QToolButton</a> and <a href="q3mainwindow.html">Q3MainWindow</a>.</p>
<hr />
<h2>Property Documentation</h2>
<h3 class="fn"><a name="label-prop"></a>label : <a href="qstring.html">QString</a></h3>
<p>This property holds the toolbar's label.</p>
<p>If the toolbar is floated the label becomes the toolbar window's caption. There is no default label text.</p>
<p>Access functions:</p>
<ul>
<li><div class="fn"/><b>QString label () const</b></li>
<li><div class="fn"/><b>virtual void setLabel ( const QString &amp; )</b></li>
</ul>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="Q3ToolBar"></a>Q3ToolBar::Q3ToolBar ( const <a href="qstring.html">QString</a> &amp; <i>label</i>, <a href="q3mainwindow.html">Q3MainWindow</a> * <i>parent</i>, <a href="qt-qt3.html#ToolBarDock-typedef">Qt::ToolBarDock</a> <i>dock</i> = Qt::DockTop, bool <i>newLine</i> = false, const char * <i>name</i> = 0 )</h3>
<p>Constructs an empty toolbar.</p>
<p>The toolbar is called <i>name</i> and is a child of <i>parent</i> and is managed by <i>parent</i>. It is initially located in dock area <i>dock</i> and is labeled <i>label</i>. If <i>newLine</i> is true the toolbar will be placed on a new line in the dock area.</p>
<h3 class="fn"><a name="Q3ToolBar-2"></a>Q3ToolBar::Q3ToolBar ( const <a href="qstring.html">QString</a> &amp; <i>label</i>, <a href="q3mainwindow.html">Q3MainWindow</a> * <i>mainWindow</i>, <a href="qwidget.html">QWidget</a> * <i>parent</i>, bool <i>newLine</i> = false, const char * <i>name</i> = 0, <a href="qt.html#WindowType-enum">Qt::WindowFlags</a> <i>f</i> = 0 )</h3>
<p>Constructs an empty horizontal toolbar.</p>
<p>The toolbar is called <i>name</i> and is a child of <i>parent</i> and is managed by <i>mainWindow</i>. The <i>label</i> and <i>newLine</i> parameters are passed straight to <a href="q3mainwindow.html#addDockWindow">Q3MainWindow::addDockWindow</a>(). <i>name</i> and the widget flags <i>f</i> are passed on to the <a href="q3dockwindow.html">Q3DockWindow</a> constructor.</p>
<p>Use this constructor if you want to create torn-off (undocked, floating) toolbars or toolbars in the <a href="qstatusbar.html">status bar</a>.</p>
<h3 class="fn"><a name="Q3ToolBar-3"></a>Q3ToolBar::Q3ToolBar ( <a href="q3mainwindow.html">Q3MainWindow</a> * <i>parent</i> = 0, const char * <i>name</i> = 0 )</h3>
<p>Constructs an empty toolbar called <i>name</i>, with parent <i>parent</i>, in its <i>parent</i>'s top dock area, without any label and without requiring a newline.</p>
<h3 class="fn"><a name="dtor.Q3ToolBar"></a>Q3ToolBar::~Q3ToolBar ()</h3>
<p>Destructor.</p>
<h3 class="fn"><a name="addSeparator"></a>void Q3ToolBar::addSeparator ()</h3>
<p>Adds a separator to the right/bottom of the toolbar.</p>
<h3 class="fn"><a name="clear"></a>void Q3ToolBar::clear ()&nbsp;&nbsp;<tt> [virtual]</tt></h3>
<p>Deletes all the toolbar's child widgets.</p>
<h3 class="fn"><a name="mainWindow"></a><a href="q3mainwindow.html">Q3MainWindow</a> * Q3ToolBar::mainWindow () const</h3>
<p>Returns a pointer to the <a href="q3mainwindow.html">Q3MainWindow</a> which manages this toolbar.</p>
<h3 class="fn"><a name="setStretchableWidget"></a>void Q3ToolBar::setStretchableWidget ( <a href="qwidget.html">QWidget</a> * <i>w</i> )&nbsp;&nbsp;<tt> [virtual]</tt></h3>
<p>Sets the widget <i>w</i> to be expanded if this toolbar is requested to stretch.</p>
<p>The request to stretch might occur because <a href="q3mainwindow.html">Q3MainWindow</a> right-justifies the dock area the toolbar is in, or because this toolbar's <a href="q3dockwindow.html#isVerticalStretchable">isVerticalStretchable</a>() or <a href="q3dockwindow.html#isHorizontalStretchable">isHorizontalStretchable</a>() is set to true.</p>
<p>If you call this function and the toolbar is not yet stretchable, setStretchable() is called.</p>
<p>See also <a href="q3mainwindow.html#rightJustification-prop">Q3MainWindow::setRightJustification</a>(), <a href="q3dockwindow.html#setVerticalStretchable">setVerticalStretchable</a>(), and <a href="q3dockwindow.html#setHorizontalStretchable">setHorizontalStretchable</a>().</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%">Copyright &copy; 2008 <a href="trolltech.html">Trolltech</a></td>
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt 4.3.5</div></td>
</tr></table></div></address></body>
</html>
